<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Class template generalized_inverse_gaussian_distribution</title>
<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
<link rel="up" href="../../boost_random/reference.html#doxygen.headers.generalized__inverse__gaussian__distribution_8hpp" title="Header &lt;boost/random/generalized_inverse_gaussian_distribution.hpp&gt;">
<link rel="prev" href="classboost_1_1random_1_1gamma__distribution_1_1param__type.html" title="Class param_type">
<link rel="next" href="classboost_1_1random_1_1generalized__inverse__gaussian__distribution_1_1param__type.html" title="Class param_type">
<meta name="viewport" content="width=device-width, initial-scale=1">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
<td align="center"><a href="../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="classboost_1_1random_1_1gamma__distribution_1_1param__type.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_random/reference.html#doxygen.headers.generalized__inverse__gaussian__distribution_8hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="classboost_1_1random_1_1generalized__inverse__gaussian__distribution_1_1param__type.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="refentry">
<a name="doxygen.headers.classboost_1_1random_1_1generalized__inverse__gaussian__distribution"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Class template generalized_inverse_gaussian_distribution</span></h2>
<p>boost::random::generalized_inverse_gaussian_distribution</p>
</div>
<h2 class="refsynopsisdiv-title">Synopsis</h2>
<div class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: &lt;<a class="link" href="../../boost_random/reference.html#doxygen.headers.generalized__inverse__gaussian__distribution_8hpp" title="Header &lt;boost/random/generalized_inverse_gaussian_distribution.hpp&gt;">boost/random/generalized_inverse_gaussian_distribution.hpp</a>&gt;

</span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> RealType <span class="special">=</span> <span class="keyword">double</span><span class="special">&gt;</span> 
<span class="keyword">class</span> <a class="link" href="classboost_1_1random_1_1generalized__inverse__gaussian__distribution.html" title="Class template generalized_inverse_gaussian_distribution">generalized_inverse_gaussian_distribution</a> <span class="special">{</span>
<span class="keyword">public</span><span class="special">:</span>
  <span class="comment">// types</span>
  <span class="keyword">typedef</span> <span class="identifier">RealType</span> <a name="doxygen.headers.classboost_1_1random_1_1generalized__inverse__gaussian__distribution_1ad4233aae00e6b29f42ae490969b2e2fe"></a><span class="identifier">result_type</span><span class="special">;</span>
  <span class="keyword">typedef</span> <span class="identifier">RealType</span> <a name="doxygen.headers.classboost_1_1random_1_1generalized__inverse__gaussian__distribution_1a90a9576095e3f1bc132dd3b58122fb67"></a><span class="identifier">input_type</span><span class="special">;</span> 

  <span class="comment">// member classes/structs/unions</span>

  <span class="keyword">class</span> <a class="link" href="classboost_1_1random_1_1generalized__inverse__gaussian__distribution_1_1param__type.html" title="Class param_type">param_type</a> <span class="special">{</span>
  <span class="keyword">public</span><span class="special">:</span>
    <span class="comment">// types</span>
    <span class="keyword">typedef</span> <a class="link" href="classboost_1_1random_1_1generalized__inverse__gaussian__distribution.html" title="Class template generalized_inverse_gaussian_distribution">generalized_inverse_gaussian_distribution</a> <a class="link" href="classboost_1_1random_1_1generalized__inverse__gaussian__distribution_1_1param__type.html#doxygen.headers.classboost_1_1random_1_1generalized__inverse__gaussian__distribution_1_1param__type_1a645f16c01f6ebb91f3e3704f04fb232c"><span class="identifier">distribution_type</span></a><span class="special">;</span>

    <span class="comment">// <a class="link" href="classboost_1_1random_1_1generalized__inverse__gaussian__distribution_1_1param__type.html#id-1_3_32_5_6_16_1_1_1_3_2-bb">public member functions</a></span>
    <span class="keyword">explicit</span> <a class="link" href="classboost_1_1random_1_1generalized__inverse__gaussian__distribution_1_1param__type.html#doxygen.headers.classboost_1_1random_1_1generalized__inverse__gaussian__distribution_1_1param__type_1a1631bc1207c43f6dffc36f43855f253d"><span class="identifier">param_type</span></a><span class="special">(</span><span class="identifier">RealType</span> <span class="special">=</span> <span class="number">1</span><span class="special">.</span><span class="number">0</span><span class="special">,</span> <span class="identifier">RealType</span> <span class="special">=</span> <span class="number">1</span><span class="special">.</span><span class="number">0</span><span class="special">,</span> <span class="identifier">RealType</span> <span class="special">=</span> <span class="number">1</span><span class="special">.</span><span class="number">0</span><span class="special">)</span><span class="special">;</span>
    <span class="identifier">RealType</span> <a class="link" href="classboost_1_1random_1_1generalized__inverse__gaussian__distribution_1_1param__type.html#doxygen.headers.classboost_1_1random_1_1generalized__inverse__gaussian__distribution_1_1param__type_1a67b0a8109066cf56bf77b87b2b6e3d4f"><span class="identifier">p</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
    <span class="identifier">RealType</span> <a class="link" href="classboost_1_1random_1_1generalized__inverse__gaussian__distribution_1_1param__type.html#doxygen.headers.classboost_1_1random_1_1generalized__inverse__gaussian__distribution_1_1param__type_1a8c66019cddd9edd394a467a67661dca7"><span class="identifier">a</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
    <span class="identifier">RealType</span> <a class="link" href="classboost_1_1random_1_1generalized__inverse__gaussian__distribution_1_1param__type.html#doxygen.headers.classboost_1_1random_1_1generalized__inverse__gaussian__distribution_1_1param__type_1ae87ae631c462ee053a391995066d6c7b"><span class="identifier">b</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>

    <span class="comment">// <a class="link" href="classboost_1_1random_1_1generalized__inverse__gaussian__distribution_1_1param__type.html#id-1_3_32_5_6_16_1_1_1_3_3-bb">friend functions</a></span>
    <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> CharT<span class="special">,</span> <span class="keyword">typename</span> Traits<span class="special">&gt;</span> 
      <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_ostream</span><span class="special">&lt;</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">&gt;</span> <span class="special">&amp;</span> 
      <a class="link" href="classboost_1_1random_1_1generalized__inverse__gaussian__distribution_1_1param__type.html#doxygen.headers.classboost_1_1random_1_1generalized__inverse__gaussian__distribution_1_1param__type_1a36d2820c7e758fa1a94fdd5d74949e54"><span class="keyword">operator</span><span class="special">&lt;&lt;</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_ostream</span><span class="special">&lt;</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">&gt;</span> <span class="special">&amp;</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="classboost_1_1random_1_1generalized__inverse__gaussian__distribution_1_1param__type.html" title="Class param_type">param_type</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
    <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> CharT<span class="special">,</span> <span class="keyword">typename</span> Traits<span class="special">&gt;</span> 
      <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_istream</span><span class="special">&lt;</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">&gt;</span> <span class="special">&amp;</span> 
      <a class="link" href="classboost_1_1random_1_1generalized__inverse__gaussian__distribution_1_1param__type.html#doxygen.headers.classboost_1_1random_1_1generalized__inverse__gaussian__distribution_1_1param__type_1aa94ff75dd5871ee80a6fc0a095c75bd0"><span class="keyword">operator</span><span class="special">&gt;&gt;</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_istream</span><span class="special">&lt;</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">&gt;</span> <span class="special">&amp;</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="classboost_1_1random_1_1generalized__inverse__gaussian__distribution_1_1param__type.html" title="Class param_type">param_type</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
    <span class="keyword">bool</span> <a class="link" href="classboost_1_1random_1_1generalized__inverse__gaussian__distribution_1_1param__type.html#doxygen.headers.classboost_1_1random_1_1generalized__inverse__gaussian__distribution_1_1param__type_1ae6f3b58e629ce7a54b5e18a4f05dbc5a"><span class="keyword">operator</span><span class="special">==</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="classboost_1_1random_1_1generalized__inverse__gaussian__distribution_1_1param__type.html" title="Class param_type">param_type</a> <span class="special">&amp;</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="classboost_1_1random_1_1generalized__inverse__gaussian__distribution_1_1param__type.html" title="Class param_type">param_type</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
    <span class="keyword">bool</span> <a class="link" href="classboost_1_1random_1_1generalized__inverse__gaussian__distribution_1_1param__type.html#doxygen.headers.classboost_1_1random_1_1generalized__inverse__gaussian__distribution_1_1param__type_1aa559d0d98e88e84417364a89b83cf5b2"><span class="keyword">operator</span><span class="special">!=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="classboost_1_1random_1_1generalized__inverse__gaussian__distribution_1_1param__type.html" title="Class param_type">param_type</a> <span class="special">&amp;</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="classboost_1_1random_1_1generalized__inverse__gaussian__distribution_1_1param__type.html" title="Class param_type">param_type</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  <span class="special">}</span><span class="special">;</span>

  <span class="comment">// <a class="link" href="classboost_1_1random_1_1generalized__inverse__gaussian__distribution.html#id-1_3_32_5_6_16_1_1_1_6-bb">public member functions</a></span>
  <span class="keyword">explicit</span> <a class="link" href="classboost_1_1random_1_1generalized__inverse__gaussian__distribution.html#doxygen.headers.classboost_1_1random_1_1generalized__inverse__gaussian__distribution_1ae7e2f57ed2ad6dc1abf8c368a7ca80ee"><span class="identifier">generalized_inverse_gaussian_distribution</span></a><span class="special">(</span><span class="identifier">RealType</span> <span class="special">=</span> <span class="number">1</span><span class="special">.</span><span class="number">0</span><span class="special">,</span> 
                                                     <span class="identifier">RealType</span> <span class="special">=</span> <span class="number">1</span><span class="special">.</span><span class="number">0</span><span class="special">,</span> 
                                                     <span class="identifier">RealType</span> <span class="special">=</span> <span class="number">1</span><span class="special">.</span><span class="number">0</span><span class="special">)</span><span class="special">;</span>
  <span class="keyword">explicit</span> <a class="link" href="classboost_1_1random_1_1generalized__inverse__gaussian__distribution.html#doxygen.headers.classboost_1_1random_1_1generalized__inverse__gaussian__distribution_1a83e7998be5ce56be1231389d8d54b80a"><span class="identifier">generalized_inverse_gaussian_distribution</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="classboost_1_1random_1_1generalized__inverse__gaussian__distribution_1_1param__type.html" title="Class param_type">param_type</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> URNG<span class="special">&gt;</span> <span class="identifier">RealType</span> <a class="link" href="classboost_1_1random_1_1generalized__inverse__gaussian__distribution.html#doxygen.headers.classboost_1_1random_1_1generalized__inverse__gaussian__distribution_1a56a95bde14557f579bde8b9cb6377079"><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span></a><span class="special">(</span><span class="identifier">URNG</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> URNG<span class="special">&gt;</span> 
    <span class="identifier">result_type</span> <a class="link" href="classboost_1_1random_1_1generalized__inverse__gaussian__distribution.html#doxygen.headers.classboost_1_1random_1_1generalized__inverse__gaussian__distribution_1af4a2ec46061503ae41c791daa886ce8e"><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span></a><span class="special">(</span><span class="identifier">URNG</span> <span class="special">&amp;</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="classboost_1_1random_1_1generalized__inverse__gaussian__distribution_1_1param__type.html" title="Class param_type">param_type</a> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  <span class="identifier">RealType</span> <a class="link" href="classboost_1_1random_1_1generalized__inverse__gaussian__distribution.html#doxygen.headers.classboost_1_1random_1_1generalized__inverse__gaussian__distribution_1ab036a370b21c2e384cc14e3151e003ac"><span class="identifier">p</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  <span class="identifier">RealType</span> <a class="link" href="classboost_1_1random_1_1generalized__inverse__gaussian__distribution.html#doxygen.headers.classboost_1_1random_1_1generalized__inverse__gaussian__distribution_1a155cad438d2935d74d9c20d1023652ad"><span class="identifier">a</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  <span class="identifier">RealType</span> <a class="link" href="classboost_1_1random_1_1generalized__inverse__gaussian__distribution.html#doxygen.headers.classboost_1_1random_1_1generalized__inverse__gaussian__distribution_1aced8710632ea086fe3c4f3fd00a675ac"><span class="identifier">b</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  <span class="identifier">RealType</span> <a class="link" href="classboost_1_1random_1_1generalized__inverse__gaussian__distribution.html#doxygen.headers.classboost_1_1random_1_1generalized__inverse__gaussian__distribution_1afcc7fc56f735b70c2461b07c6a60f153"><span class="identifier">min</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  <span class="identifier">RealType</span> <a class="link" href="classboost_1_1random_1_1generalized__inverse__gaussian__distribution.html#doxygen.headers.classboost_1_1random_1_1generalized__inverse__gaussian__distribution_1af63457a6aad00a62d2a4bfd987a9ab3a"><span class="identifier">max</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  <a class="link" href="classboost_1_1random_1_1generalized__inverse__gaussian__distribution_1_1param__type.html" title="Class param_type">param_type</a> <a class="link" href="classboost_1_1random_1_1generalized__inverse__gaussian__distribution.html#doxygen.headers.classboost_1_1random_1_1generalized__inverse__gaussian__distribution_1abc81177c6f653f361c395110079433b7"><span class="identifier">param</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  <span class="keyword">void</span> <a class="link" href="classboost_1_1random_1_1generalized__inverse__gaussian__distribution.html#doxygen.headers.classboost_1_1random_1_1generalized__inverse__gaussian__distribution_1a2f09890d37f2d818369e826497c38aa6"><span class="identifier">param</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="classboost_1_1random_1_1generalized__inverse__gaussian__distribution_1_1param__type.html" title="Class param_type">param_type</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  <span class="keyword">void</span> <a class="link" href="classboost_1_1random_1_1generalized__inverse__gaussian__distribution.html#doxygen.headers.classboost_1_1random_1_1generalized__inverse__gaussian__distribution_1aa8ecdcb6a82c3c87edda7d10e376178d"><span class="identifier">reset</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>

  <span class="comment">// <a class="link" href="classboost_1_1random_1_1generalized__inverse__gaussian__distribution.html#id-1_3_32_5_6_16_1_1_1_7-bb">friend functions</a></span>
  <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> CharT<span class="special">,</span> <span class="keyword">typename</span> Traits<span class="special">&gt;</span> 
    <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_ostream</span><span class="special">&lt;</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">&gt;</span> <span class="special">&amp;</span> 
    <a class="link" href="classboost_1_1random_1_1generalized__inverse__gaussian__distribution.html#doxygen.headers.classboost_1_1random_1_1generalized__inverse__gaussian__distribution_1aa3a4073637eab72125cd1151ed94ceb2"><span class="keyword">operator</span><span class="special">&lt;&lt;</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_ostream</span><span class="special">&lt;</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">&gt;</span> <span class="special">&amp;</span><span class="special">,</span> 
               <span class="keyword">const</span> <a class="link" href="classboost_1_1random_1_1generalized__inverse__gaussian__distribution.html" title="Class template generalized_inverse_gaussian_distribution">generalized_inverse_gaussian_distribution</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> CharT<span class="special">,</span> <span class="keyword">typename</span> Traits<span class="special">&gt;</span> 
    <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_istream</span><span class="special">&lt;</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">&gt;</span> <span class="special">&amp;</span> 
    <a class="link" href="classboost_1_1random_1_1generalized__inverse__gaussian__distribution.html#doxygen.headers.classboost_1_1random_1_1generalized__inverse__gaussian__distribution_1a67b44676de2b68a25c0885b87351c059"><span class="keyword">operator</span><span class="special">&gt;&gt;</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_istream</span><span class="special">&lt;</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">&gt;</span> <span class="special">&amp;</span><span class="special">,</span> 
               <span class="keyword">const</span> <a class="link" href="classboost_1_1random_1_1generalized__inverse__gaussian__distribution.html" title="Class template generalized_inverse_gaussian_distribution">generalized_inverse_gaussian_distribution</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  <span class="keyword">bool</span> <a class="link" href="classboost_1_1random_1_1generalized__inverse__gaussian__distribution.html#doxygen.headers.classboost_1_1random_1_1generalized__inverse__gaussian__distribution_1a889d8b4f437dc0e02a65c3a37fc0fcc0"><span class="keyword">operator</span><span class="special">==</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="classboost_1_1random_1_1generalized__inverse__gaussian__distribution.html" title="Class template generalized_inverse_gaussian_distribution">generalized_inverse_gaussian_distribution</a> <span class="special">&amp;</span><span class="special">,</span> 
                  <span class="keyword">const</span> <a class="link" href="classboost_1_1random_1_1generalized__inverse__gaussian__distribution.html" title="Class template generalized_inverse_gaussian_distribution">generalized_inverse_gaussian_distribution</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  <span class="keyword">bool</span> <a class="link" href="classboost_1_1random_1_1generalized__inverse__gaussian__distribution.html#doxygen.headers.classboost_1_1random_1_1generalized__inverse__gaussian__distribution_1ae76f87d1595cd0fd6d2f85f6d36801fb"><span class="keyword">operator</span><span class="special">!=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="classboost_1_1random_1_1generalized__inverse__gaussian__distribution.html" title="Class template generalized_inverse_gaussian_distribution">generalized_inverse_gaussian_distribution</a> <span class="special">&amp;</span><span class="special">,</span> 
                  <span class="keyword">const</span> <a class="link" href="classboost_1_1random_1_1generalized__inverse__gaussian__distribution.html" title="Class template generalized_inverse_gaussian_distribution">generalized_inverse_gaussian_distribution</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
<span class="special">}</span><span class="special">;</span></pre></div>
<div class="refsect1">
<a name="id-1.3.32.5.6.15.3.4"></a><h2>Description</h2>
<p>The generalized inverse gaussian distribution is a real-valued distribution with three parameters p, a, and b. It produced values &gt; 0.</p>
<p>It has <span class="inlinemediaobject"><img src="../../images/random//form_58.png"></span>. where <span class="inlinemediaobject"><img src="../../images/random//form_59.png"></span> is a modified Bessel function of the second kind.</p>
<p>The algorithm used is from</p>
<p> </p>
<div class="blockquote"><blockquote class="blockquote"><p>  "Random variate generation for the generalized inverse Gaussian distribution", Luc Devroye, Statistics and Computing, Volume 24, 2014, Pages 236 - 246  </p></blockquote></div>
<p>  </p>
<div class="refsect2">
<a name="id-1.3.32.5.6.15.3.4.6"></a><h3>
<a name="id-1_3_32_5_6_16_1_1_1_6-bb"></a><code class="computeroutput">generalized_inverse_gaussian_distribution</code> public member functions</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem">
<pre class="literallayout"><span class="keyword">explicit</span> <a name="doxygen.headers.classboost_1_1random_1_1generalized__inverse__gaussian__distribution_1ae7e2f57ed2ad6dc1abf8c368a7ca80ee"></a><span class="identifier">generalized_inverse_gaussian_distribution</span><span class="special">(</span><span class="identifier">RealType</span> p <span class="special">=</span> <span class="number">1</span><span class="special">.</span><span class="number">0</span><span class="special">,</span> 
                                                   <span class="identifier">RealType</span> a <span class="special">=</span> <span class="number">1</span><span class="special">.</span><span class="number">0</span><span class="special">,</span> 
                                                   <span class="identifier">RealType</span> b <span class="special">=</span> <span class="number">1</span><span class="special">.</span><span class="number">0</span><span class="special">)</span><span class="special">;</span></pre>
<p>Constructs an <code class="computeroutput"><a class="link" href="classboost_1_1random_1_1generalized__inverse__gaussian__distribution.html" title="Class template generalized_inverse_gaussian_distribution">generalized_inverse_gaussian_distribution</a></code> from its "p", "a", and "b" parameters.</p>
<p>Requires: a &gt; 0 &amp;&amp; b &gt;= 0 if p &gt; 0, a &gt; 0 &amp;&amp; b &gt; 0 if p == 0, a &gt;= 0 &amp;&amp; b &gt; 0 if p &lt; 0 </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">explicit</span> <a name="doxygen.headers.classboost_1_1random_1_1generalized__inverse__gaussian__distribution_1a83e7998be5ce56be1231389d8d54b80a"></a><span class="identifier">generalized_inverse_gaussian_distribution</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="classboost_1_1random_1_1generalized__inverse__gaussian__distribution_1_1param__type.html" title="Class param_type">param_type</a> <span class="special">&amp;</span> param<span class="special">)</span><span class="special">;</span></pre>
<p>Constructs an <code class="computeroutput"><a class="link" href="classboost_1_1random_1_1generalized__inverse__gaussian__distribution.html" title="Class template generalized_inverse_gaussian_distribution">generalized_inverse_gaussian_distribution</a></code> from its parameters. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> URNG<span class="special">&gt;</span> <span class="identifier">RealType</span> <a name="doxygen.headers.classboost_1_1random_1_1generalized__inverse__gaussian__distribution_1a56a95bde14557f579bde8b9cb6377079"></a><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span><span class="special">(</span><span class="identifier">URNG</span> <span class="special">&amp;</span> urng<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p>Returns a random variate distributed according to the generalized inverse gaussian distribution. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> URNG<span class="special">&gt;</span> 
  <span class="identifier">result_type</span> <a name="doxygen.headers.classboost_1_1random_1_1generalized__inverse__gaussian__distribution_1af4a2ec46061503ae41c791daa886ce8e"></a><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span><span class="special">(</span><span class="identifier">URNG</span> <span class="special">&amp;</span> urng<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="classboost_1_1random_1_1generalized__inverse__gaussian__distribution_1_1param__type.html" title="Class param_type">param_type</a> <span class="special">&amp;</span> param<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p>Returns a random variate distributed accordint to the beta distribution with parameters specified by <code class="computeroutput">param</code>. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="identifier">RealType</span> <a name="doxygen.headers.classboost_1_1random_1_1generalized__inverse__gaussian__distribution_1ab036a370b21c2e384cc14e3151e003ac"></a><span class="identifier">p</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p>Returns the "p" parameter of the distribution. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="identifier">RealType</span> <a name="doxygen.headers.classboost_1_1random_1_1generalized__inverse__gaussian__distribution_1a155cad438d2935d74d9c20d1023652ad"></a><span class="identifier">a</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p>Returns the "a" parameter of the distribution. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="identifier">RealType</span> <a name="doxygen.headers.classboost_1_1random_1_1generalized__inverse__gaussian__distribution_1aced8710632ea086fe3c4f3fd00a675ac"></a><span class="identifier">b</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p>Returns the "b" parameter of the distribution. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="identifier">RealType</span> <a name="doxygen.headers.classboost_1_1random_1_1generalized__inverse__gaussian__distribution_1afcc7fc56f735b70c2461b07c6a60f153"></a><span class="identifier">min</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p>Returns the smallest value that the distribution can produce. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="identifier">RealType</span> <a name="doxygen.headers.classboost_1_1random_1_1generalized__inverse__gaussian__distribution_1af63457a6aad00a62d2a4bfd987a9ab3a"></a><span class="identifier">max</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p>Returns the largest value that the distribution can produce. </p>
</li>
<li class="listitem">
<pre class="literallayout"><a class="link" href="classboost_1_1random_1_1generalized__inverse__gaussian__distribution_1_1param__type.html" title="Class param_type">param_type</a> <a name="doxygen.headers.classboost_1_1random_1_1generalized__inverse__gaussian__distribution_1abc81177c6f653f361c395110079433b7"></a><span class="identifier">param</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p>Returns the parameters of the distribution. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">void</span> <a name="doxygen.headers.classboost_1_1random_1_1generalized__inverse__gaussian__distribution_1a2f09890d37f2d818369e826497c38aa6"></a><span class="identifier">param</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="classboost_1_1random_1_1generalized__inverse__gaussian__distribution_1_1param__type.html" title="Class param_type">param_type</a> <span class="special">&amp;</span> param<span class="special">)</span><span class="special">;</span></pre>
<p>Sets the parameters of the distribution. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">void</span> <a name="doxygen.headers.classboost_1_1random_1_1generalized__inverse__gaussian__distribution_1aa8ecdcb6a82c3c87edda7d10e376178d"></a><span class="identifier">reset</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
<p>Effects: Subsequent uses of the distribution do not depend on values produced by any engine prior to invoking reset. </p>
</li>
</ol></div>
</div>
<div class="refsect2">
<a name="id-1.3.32.5.6.15.3.4.7"></a><h3>
<a name="id-1_3_32_5_6_16_1_1_1_7-bb"></a><code class="computeroutput">generalized_inverse_gaussian_distribution</code> friend functions</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem">
<pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> CharT<span class="special">,</span> <span class="keyword">typename</span> Traits<span class="special">&gt;</span> 
  <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_ostream</span><span class="special">&lt;</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">&gt;</span> <span class="special">&amp;</span> 
  <a name="doxygen.headers.classboost_1_1random_1_1generalized__inverse__gaussian__distribution_1aa3a4073637eab72125cd1151ed94ceb2"></a><span class="keyword">operator</span><span class="special">&lt;&lt;</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_ostream</span><span class="special">&lt;</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">&gt;</span> <span class="special">&amp;</span> os<span class="special">,</span> 
             <span class="keyword">const</span> <a class="link" href="classboost_1_1random_1_1generalized__inverse__gaussian__distribution.html" title="Class template generalized_inverse_gaussian_distribution">generalized_inverse_gaussian_distribution</a> <span class="special">&amp;</span> wd<span class="special">)</span><span class="special">;</span></pre>
<p>Writes an <code class="computeroutput"><a class="link" href="classboost_1_1random_1_1generalized__inverse__gaussian__distribution.html" title="Class template generalized_inverse_gaussian_distribution">generalized_inverse_gaussian_distribution</a></code> to a <code class="computeroutput">std::ostream</code>. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> CharT<span class="special">,</span> <span class="keyword">typename</span> Traits<span class="special">&gt;</span> 
  <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_istream</span><span class="special">&lt;</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">&gt;</span> <span class="special">&amp;</span> 
  <a name="doxygen.headers.classboost_1_1random_1_1generalized__inverse__gaussian__distribution_1a67b44676de2b68a25c0885b87351c059"></a><span class="keyword">operator</span><span class="special">&gt;&gt;</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_istream</span><span class="special">&lt;</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">&gt;</span> <span class="special">&amp;</span> is<span class="special">,</span> 
             <span class="keyword">const</span> <a class="link" href="classboost_1_1random_1_1generalized__inverse__gaussian__distribution.html" title="Class template generalized_inverse_gaussian_distribution">generalized_inverse_gaussian_distribution</a> <span class="special">&amp;</span> wd<span class="special">)</span><span class="special">;</span></pre>
<p>Reads an <code class="computeroutput"><a class="link" href="classboost_1_1random_1_1generalized__inverse__gaussian__distribution.html" title="Class template generalized_inverse_gaussian_distribution">generalized_inverse_gaussian_distribution</a></code> from a <code class="computeroutput">std::istream</code>. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">bool</span> <a name="doxygen.headers.classboost_1_1random_1_1generalized__inverse__gaussian__distribution_1a889d8b4f437dc0e02a65c3a37fc0fcc0"></a><span class="keyword">operator</span><span class="special">==</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="classboost_1_1random_1_1generalized__inverse__gaussian__distribution.html" title="Class template generalized_inverse_gaussian_distribution">generalized_inverse_gaussian_distribution</a> <span class="special">&amp;</span> lhs<span class="special">,</span> 
                <span class="keyword">const</span> <a class="link" href="classboost_1_1random_1_1generalized__inverse__gaussian__distribution.html" title="Class template generalized_inverse_gaussian_distribution">generalized_inverse_gaussian_distribution</a> <span class="special">&amp;</span> rhs<span class="special">)</span><span class="special">;</span></pre>
<p>Returns true if the two instances of <code class="computeroutput"><a class="link" href="classboost_1_1random_1_1generalized__inverse__gaussian__distribution.html" title="Class template generalized_inverse_gaussian_distribution">generalized_inverse_gaussian_distribution</a></code> will return identical sequences of values given equal generators. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">bool</span> <a name="doxygen.headers.classboost_1_1random_1_1generalized__inverse__gaussian__distribution_1ae76f87d1595cd0fd6d2f85f6d36801fb"></a><span class="keyword">operator</span><span class="special">!=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="classboost_1_1random_1_1generalized__inverse__gaussian__distribution.html" title="Class template generalized_inverse_gaussian_distribution">generalized_inverse_gaussian_distribution</a> <span class="special">&amp;</span> lhs<span class="special">,</span> 
                <span class="keyword">const</span> <a class="link" href="classboost_1_1random_1_1generalized__inverse__gaussian__distribution.html" title="Class template generalized_inverse_gaussian_distribution">generalized_inverse_gaussian_distribution</a> <span class="special">&amp;</span> rhs<span class="special">)</span><span class="special">;</span></pre>
<p>Returns true if the two instances of <code class="computeroutput"><a class="link" href="classboost_1_1random_1_1generalized__inverse__gaussian__distribution.html" title="Class template generalized_inverse_gaussian_distribution">generalized_inverse_gaussian_distribution</a></code> will return different sequences of values given equal generators. </p>
</li>
</ol></div>
</div>
</div>
</div>
<div class="copyright-footer">Copyright © 2000-2005 Jens Maurer<br>Copyright © 2009, 2010 Steven Watanabe<br>Copyright © 2022-2025 Matt
      Borland<p>
        Distributed under the Boost Software License, Version 1.0. (See accompanying
        file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
      </p>
</div>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="classboost_1_1random_1_1gamma__distribution_1_1param__type.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_random/reference.html#doxygen.headers.generalized__inverse__gaussian__distribution_8hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="classboost_1_1random_1_1generalized__inverse__gaussian__distribution_1_1param__type.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>
